/**
 * Copyright 2020 OPSLI 快速开发平台 https://www.opsli.com
 * <p>
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package org.opsli.api.web.customer.customerrelation;

import org.opsli.api.base.result.ResultWrapper;
import org.opsli.api.wrapper.customer.customerrelation.CustomerStudentRelationModel;
import org.opsli.api.wrapper.customer.customerrelation.CustomerStudentRelationQueryModel;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartHttpServletRequest;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * 客户关系 Api
 * <p>
 * 对外 API 直接 暴露 @GetMapping 或者 @PostMapping
 * 对内也推荐 单机版 不需要设置 Mapping 但是调用方法得从Controller写起
 * <p>
 * 这样写法虽然比较绕，但是当单体项目想要改造微服务架构时 时非常容易的
 *
 * @author guagua
 * @date 2025-06-29 00:14:23
 */
public interface CustomerStudentRelationRestApi {

    /**
     * 标题
     */
    String TITLE = "客户关系";
    /**
     * 子标题
     */
    String SUB_TITLE = "客户关系";

    /**
     * 客户关系 查一条
     *
     * @param model 模型
     * @return ResultWrapper
     */
    @GetMapping("/get")
    ResultWrapper<CustomerStudentRelationModel> get(CustomerStudentRelationModel model);

    /**
     * 客户关系 查询分页
     *
     * @param pageNo   当前页
     * @param pageSize 每页条数
     * @param request  request
     * @return ResultWrapper
     */
    @GetMapping("/findPage")
    ResultWrapper<?> findPage(
            @RequestParam(name = "pageNo", defaultValue = "1") Integer pageNo,
            @RequestParam(name = "pageSize", defaultValue = "10") Integer pageSize,
            HttpServletRequest request);

    /**
     * 客户关系详细信息 查询分页（包含客户和学生信息）
     *
     * @param pageNo   当前页
     * @param pageSize 每页条数
     * @param request  请求对象，支持动态查询条件
     * @return ResultWrapper
     */
    @GetMapping("/findPageWithDetails")
    ResultWrapper<?> findPageWithDetails(
            @RequestParam(name = "pageNo", defaultValue = "1") Integer pageNo,
            @RequestParam(name = "pageSize", defaultValue = "10") Integer pageSize,
            HttpServletRequest request);

    /**
     * 客户关系详细信息 查询分页（支持嵌套查询参数）
     *
     * @param pageNo     当前页
     * @param pageSize   每页条数
     * @param queryModel 查询条件模型
     * @return ResultWrapper
     */
    @PostMapping("/findPageWithDetailsV2")
    ResultWrapper<?> findPageWithDetailsV2(
            @RequestBody CustomerStudentRelationQueryModel queryModel, HttpServletRequest request);

    /**
     * 根据ID查询客户关系详细信息（包含客户和学生信息）
     *
     * @param id 关系ID
     * @return ResultWrapper
     */
    @GetMapping("/getWithDetails/{id}")
    ResultWrapper<CustomerStudentRelationModel> getWithDetails(@PathVariable("id") String id);

    /**
     * 客户关系 新增
     *
     * @param model 模型
     * @return ResultWrapper
     */
    @PostMapping("/insert")
    ResultWrapper<?> insert(@RequestBody CustomerStudentRelationModel model);

    /**
     * 客户关系 修改
     *
     * @param model 模型
     * @return ResultWrapper
     */
    @PostMapping("/update")
    ResultWrapper<?> update(@RequestBody CustomerStudentRelationModel model);

    /**
     * 客户关系 删除
     *
     * @param id ID
     * @return ResultWrapper
     */
    @PostMapping("/del")
    ResultWrapper<?> del(String id);

    /**
     * 客户关系 批量删除
     *
     * @param ids ID 数组
     * @return ResultWrapper
     */
    @PostMapping("/delAll")
    ResultWrapper<?> delAll(String ids);

    /**
     * 客户关系 Excel 导出认证
     *
     * @param type    类型
     * @param request request
     */
    @GetMapping("/excel/auth/{type}")
    ResultWrapper<String> exportExcelAuth(
            @PathVariable("type") String type,
            HttpServletRequest request);

    /**
     * 客户关系 Excel 导出
     *
     * @param certificate 凭证
     * @param response    response
     */
    @GetMapping("/excel/export/{certificate}")
    void exportExcel(
            @PathVariable("certificate") String certificate,
            HttpServletResponse response);

    /**
     * 客户关系 Excel 导入
     *
     * @param request 文件流 request
     * @return ResultWrapper
     */
    @PostMapping("/importExcel")
    ResultWrapper<?> importExcel(MultipartHttpServletRequest request);

}